home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / Xm / XmTextFieldGetSubstringWcs.z / XmTextFieldGetSubstringWcs
Encoding:
Text File  |  2001-04-17  |  5.6 KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmTTTTeeeexxxxttttFFFFiiiieeeellllddddGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnnggggWWWWccccssss((((UUUU3333NNNNXXXXIIII))))XXXX SSSSyyyysssstttteeeeXXXXmmmmmmmmTTTTVVVVeeeexxxxttttFFFFiiiieeeellllddddGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnnggggWWWWccccssss((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmTTTTeeeexxxxttttFFFFiiiieeeellllddddGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnnggggWWWWccccssss - A TextField function that
  10.           retrieves a portion of a wide character internal text buffer
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           #include <Xm/TextF.h>
  14.           iiiinnnntttt XXXXmmmmTTTTeeeexxxxttttFFFFiiiieeeellllddddGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnnggggWWWWccccssss(
  15.           WWWWiiiiddddggggeeeetttt wwwwiiiiddddggggeeeetttt,
  16.           XXXXmmmmTTTTeeeexxxxttttPPPPoooossssiiiittttiiiioooonnnn ssssttttaaaarrrrtttt,
  17.           iiiinnnntttt nnnnuuuummmm____cccchhhhaaaarrrrssss,
  18.           iiiinnnntttt bbbbuuuuffffffffeeeerrrr____ssssiiiizzzzeeee,
  19.           wwwwcccchhhhaaaarrrr____tttt ****bbbbuuuuffffffffeeeerrrr);
  20.  
  21.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  22.           This page documents Motif 2.1.
  23.  
  24.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  25.           XXXXmmmmTTTTeeeexxxxttttFFFFiiiieeeellllddddGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnnggggWWWWccccssss retrieves a copy of a portion of
  26.           the internal text buffer of a TextField widget that is
  27.           stored in a wide character format. The function copies a
  28.           specified number of characters from a given start position
  29.           in the internal text buffer into a buffer provided by the
  30.           application. A NULL terminator is placed at the end of the
  31.           copied data.
  32.  
  33.           _w_i_d_g_e_t    Specifies the TextField widget ID.
  34.  
  35.           _s_t_a_r_t     Specifies the beginning character position from
  36.                     which the data will be retrieved. This is an
  37.                     integer number of characters from the beginning of
  38.                     the text buffer. The first character position is 0
  39.                     (zero).
  40.  
  41.           _n_u_m__c_h_a_r_s Specifies the number of wwwwcccchhhhaaaarrrr____tttt characters to be
  42.                     copied into the provided buffer.
  43.  
  44.           _b_u_f_f_e_r__s_i_z_e
  45.                     Specifies the size of the supplied buffer as a
  46.                     number of wwwwcccchhhhaaaarrrr____ttttstorage locations. The minimum
  47.                     size is _n_u_m__c_h_a_r_s + 1.
  48.  
  49.           _b_u_f_f_e_r    Specifies the wide character buffer into which the
  50.                     internal text buffer will be copied.
  51.  
  52.           For a complete definition of TextField and its associated
  53.           resources, see XXXXmmmmTTTTeeeexxxxttttFFFFiiiieeeelllldddd(3).
  54.  
  55.      RRRREEEETTTTUUUURRRRNNNN
  56.           XXXXmmmmCCCCOOOOPPPPYYYY____SSSSUUUUCCCCCCCCEEEEEEEEDDDDEEEEDDDD
  57.                     The function was successful.
  58.  
  59.           XXXXmmmmCCCCOOOOPPPPYYYY____FFFFAAAAIIIILLLLEEEEDDDD
  60.  
  61.  
  62.  
  63.      Page 1                                           (printed 4/6/01)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmTTTTeeeexxxxttttFFFFiiiieeeellllddddGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnnggggWWWWccccssss((((UUUU3333NNNNXXXXIIII))))XXXX SSSSyyyysssstttteeeeXXXXmmmmmmmmTTTTVVVVeeeexxxxttttFFFFiiiieeeellllddddGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnnggggWWWWccccssss((((3333XXXX))))
  71.  
  72.  
  73.  
  74.                     The function failed because it was unable to copy
  75.                     the specified number of characters into the buffer
  76.                     provided.  The buffer size may be insufficient.
  77.                     The contents of _b_u_f_f_e_r are undefined.
  78.  
  79.           XXXXmmmmCCCCOOOOPPPPYYYY____TTTTRRRRUUUUNNNNCCCCAAAATTTTEEEEDDDD
  80.                     The requested number of characters extended beyond
  81.                     the internal buffer. The function copied
  82.                     characters to the end of the buffer and terminated
  83.                     the string with a NULL terminator; fewer than
  84.                     _n_u_m__c_h_a_r_s characters were copied.
  85.  
  86.      RRRREEEELLLLAAAATTTTEEEEDDDD
  87.           XXXXmmmmTTTTeeeexxxxttttFFFFiiiieeeelllldddd(3) and XXXXmmmmTTTTeeeexxxxttttFFFFiiiieeeellllddddGGGGeeeettttSSSSuuuubbbbssssttttrrrriiiinnnngggg(3).
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                           (printed 4/6/01)
  130.  
  131.  
  132.  
  133.